Class NFExporterImpl

All Implemented Interfaces:
IPCObject, NFExporter, Process

public class NFExporterImpl extends ProcessImpl implements NFExporter
Information provided by the PKI file:

    \class NFExporter
    
    \brief NFExporter handles and manipulates NetFlow exporters.
    
    \example network().getDevice("Router0").getNetflowExporterManager().getNFExporterAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getTemplateById

      public NFTemplate getTemplateById(int id)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow template with the specified ID.
          
          \param id, the ID of the NetFlow template of interest.
          
          \return NFTemplate, the NFTemplate object with the specified ID.
          
              
      Specified by:
      getTemplateById in interface NFExporter
      Parameters:
      id - Takes in a parameter of id
      Returns:
      NFTemplate Returns a NFTemplate
    • getTemplateByRecordName

      public NFTemplate getTemplateByRecordName(String recordName)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow template with the specified record name.
          
          \param recordName, the record name of the NetFlow template of interest.
          
          \return NFTemplate, the NFTemplate object with the specified record name.
          
              
      Specified by:
      getTemplateByRecordName in interface NFExporter
      Parameters:
      recordName - Takes in a parameter of recordName
      Returns:
      NFTemplate Returns a NFTemplate
    • removeTemplate

      public boolean removeTemplate(int templateId)
      Information provided by the PKI file:
      
          \brief Removes the NetFlow template with the specified ID.
          
          \param templateId, the ID of the NetFlow template of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeTemplate in interface NFExporter
      Parameters:
      templateId - Takes in a parameter of templateId
      Returns:
      boolean Returns a boolean
    • setExporterName

      public void setExporterName(String name)
      Information provided by the PKI file:
      
          \brief Sets the name for the NetFlow exporter.
          
          \param name, the name for the NetFlow exporter.
          
              
      Specified by:
      setExporterName in interface NFExporter
      Parameters:
      name - Takes in a parameter of name
    • getExporterName

      public String getExporterName()
      Information provided by the PKI file:
      
          \brief Returns the name of the NetFlow exporter.
          
          \return string, the name of the NetFlow exporter.
          
              
      Specified by:
      getExporterName in interface NFExporter
      Returns:
      String Returns a String
    • setExporterVersion

      public void setExporterVersion(int version)
      Information provided by the PKI file:
      
          \brief Sets the version for the NetFlow exporter.
          
          \param version, the version for the NetFlow exporter.
          
              
      Specified by:
      setExporterVersion in interface NFExporter
      Parameters:
      version - Takes in a parameter of version
    • getExporterVersion

      public int getExporterVersion()
      Information provided by the PKI file:
      
          \brief Returns the version of the NetFlow exporter.
          
          \return int, the version of the NetFlow exporter.
          
              
      Specified by:
      getExporterVersion in interface NFExporter
      Returns:
      int Returns a int
    • getDeviceUpTime

      public long getDeviceUpTime()
      Information provided by the PKI file:
      
          \brief Returns the device up time.
          
          \return int, the device up time.
          
              
      Specified by:
      getDeviceUpTime in interface NFExporter
      Returns:
      long Returns a long
    • isFullyConfigured

      public boolean isFullyConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the NetFlow exporter is fully configured, otherwise false.
          
          \return bool, true if the NetFlow exporter is fully configured, otherwise false.
          
              
      Specified by:
      isFullyConfigured in interface NFExporter
      Returns:
      boolean Returns a boolean
    • setSrcPort

      public void setSrcPort(String port)
      Information provided by the PKI file:
      
          \brief Sets the source port.
          
          \param port,        portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
              
      Specified by:
      setSrcPort in interface NFExporter
      Parameters:
      port - Takes in a parameter of port
    • getSrcPort

      public Port getSrcPort()
      Information provided by the PKI file:
      
          \brief Returns the source port.
          
          \return Port, the Port object of the source port.
          
              
      Specified by:
      getSrcPort in interface NFExporter
      Returns:
      Port Returns a Port
    • setDestinationAddr

      public void setDestinationAddr(IPAddress ip_add)
      Information provided by the PKI file:
      
          \brief Sets the destination IP address.
          
          \param ip_add, the IP address of the destination.
          
              
      Specified by:
      setDestinationAddr in interface NFExporter
      Parameters:
      ip_add - Takes in a parameter of ip_add
    • getDestinationAddr

      public IPAddress getDestinationAddr()
      Information provided by the PKI file:
      
          \brief Returns the destination IP address.
          
          \return ip, the IP address of the destination.
          
              
      Specified by:
      getDestinationAddr in interface NFExporter
      Returns:
      IPAddress Returns a IPAddress
    • setDestinationUdpPort

      public void setDestinationUdpPort(int port)
      Information provided by the PKI file:
      
          \brief Sets the destination UDP port number.
          
          \param port, the UDP port number for the destination.
          
              
      Specified by:
      setDestinationUdpPort in interface NFExporter
      Parameters:
      port - Takes in a parameter of port
    • getDestinationUdpPort

      public int getDestinationUdpPort()
      Information provided by the PKI file:
      
          \brief Returns the destination UDP port number.
          
          \return int, the UDP port number of the destination.
          
              
      Specified by:
      getDestinationUdpPort in interface NFExporter
      Returns:
      int Returns a int
    • addMonitor

      public void addMonitor(String monitorName)
      Information provided by the PKI file:
      
          \brief Adds a monitor with the specified name.
          
          \param monitorName, the name for the monitor.
          
              
      Specified by:
      addMonitor in interface NFExporter
      Parameters:
      monitorName - Takes in a parameter of monitorName
    • removeMontior

      public void removeMontior(String monitorName)
      Information provided by the PKI file:
      
          \brief Removes the monitor with the specified name.
          
          \param monitorName, the name of the monitor of interest.
          
              
      Specified by:
      removeMontior in interface NFExporter
      Parameters:
      monitorName - Takes in a parameter of monitorName
    • createFrameInstance

      public FrameInstance createFrameInstance()
      Information provided by the PKI file:
      
          \brief Creates a frame instance.
          
          \return FrameInstance, the FrameInstance object of the frame instance.
          
              
      Specified by:
      createFrameInstance in interface NFExporter
      Returns:
      FrameInstance Returns a FrameInstance